Edit readme to include forced overrides functionability #2233
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adamraya
reviewed
Feb 1, 2025
| In a case when it is necessary to override some files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass the restrictions. | ||
| To do this, create a `.forced_overrides` dot file at the root of your base project and list the files you intend to override. Any files specified in this list will be treated as overridable. | ||
|
|
||
| Note: It is advisable to use this function with caution since it could potential break intended behavior of installed extensions. |
There was a problem hiding this comment.
I'd also note that this should used as a temporary workaround while seeking a proper extensibility solution. Like we mention in the file docs.
adamraya
reviewed
Feb 1, 2025
| @@ -107,6 +107,12 @@ Now when the base application is built the import for the `logo.ts` in `extensio | |||
|
|
|||
| This mechanism is useful when you want to allow for fine grained customization of your application extension. Its the responsibility of the extension developer to ensure their document what files are overridable and what the expected input and output of those files are. For example, if the overridable file is a React component you should document the props that get passed to that component and the expected exports of the file. | |||
|
|
|||
| #### Forced overrides | |||
| In a case when it is necessary to override some files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass the restrictions. | |||
| To do this, create a `.forced_overrides` dot file at the root of your base project and list the files you intend to override. Any files specified in this list will be treated as overridable. | |||
There was a problem hiding this comment.
optional nit: expand on how to specify the files
Suggested change
| To do this, create a `.forced_overrides` dot file at the root of your base project and list the files you intend to override. Any files specified in this list will be treated as overridable. | |
| To do this, create a `.forced_overrides` dot file at the root of your base project, list the files you intend to override, starting with the extension package name. Any files specified in this list will be treated as overridable. |
adamraya
reviewed
Feb 1, 2025
| @@ -107,6 +107,12 @@ Now when the base application is built the import for the `logo.ts` in `extensio | |||
|
|
|||
| This mechanism is useful when you want to allow for fine grained customization of your application extension. Its the responsibility of the extension developer to ensure their document what files are overridable and what the expected input and output of those files are. For example, if the overridable file is a React component you should document the props that get passed to that component and the expected exports of the file. | |||
|
|
|||
| #### Forced overrides | |||
| In a case when it is necessary to override some files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass the restrictions. | |||
There was a problem hiding this comment.
optional nit: rephrasing a bit
Suggested change
| In a case when it is necessary to override some files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass the restrictions. | |
| Sometimes, you may need to override files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass these restrictions. |
adamraya
approved these changes
Feb 1, 2025
alexvuong
added
the
skip changelog
vmarta
reviewed
Feb 1, 2025
| @@ -107,6 +107,12 @@ Now when the base application is built the import for the `logo.ts` in `extensio | |||
|
|
|||
| This mechanism is useful when you want to allow for fine grained customization of your application extension. Its the responsibility of the extension developer to ensure their document what files are overridable and what the expected input and output of those files are. For example, if the overridable file is a React component you should document the props that get passed to that component and the expected exports of the file. | |||
|
|
|||
| #### Forced overrides | |||
| Sometimes, you may need to override some files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass these restrictions. | |||
There was a problem hiding this comment.
🤔 I'm not sure whether this is the right place to describe forced overrides. Because at this point, the readme is talking about The anatomy of an Application Extension (see line 25). But forced overrides is a feature that is used in the base project (not in the app extension).
So what is the correct place? I'm thinking template-typescript-minimal/README.md file. But that readme does not have any existing info on app extensibility.
There was a problem hiding this comment.
Typescript minimal is a private project atm. I asked the same question previously too, Adam advised we can put it here to explain about overrides machenism since the logic stays in this package. I think it is okay since we talked about overrides in this section. it is logical we can mentioned about force_overrides too
vmarta
reviewed
Feb 1, 2025
| @@ -107,6 +107,12 @@ Now when the base application is built the import for the `logo.ts` in `extensio | |||
|
|
|||
| This mechanism is useful when you want to allow for fine grained customization of your application extension. Its the responsibility of the extension developer to ensure their document what files are overridable and what the expected input and output of those files are. For example, if the overridable file is a React component you should document the props that get passed to that component and the expected exports of the file. | |||
|
|
|||
| #### Forced overrides | |||
There was a problem hiding this comment.
To match how other headings are capitalized:
Suggested change
| #### Forced overrides | |
| #### Forced Overrides |
| Sometimes, you may need to override some files from an extension but the extension developers do not allow those files to be overridden, you can use `forced_overrides` to bypass these restrictions. | ||
| To do this, create a `.forced_overrides` dot file at the root of your base project, list the files you intend to override, starting with the extension package name. Any files specified in this list will be treated as overridable. | ||
|
|
||
| Note: It is advisable to use this function with caution since it could potential break intended behavior of installed extensions. This should be used as a temporary solution to urgently patch/update an extension. |
There was a problem hiding this comment.
Suggested change
| Note: It is advisable to use this function with caution since it could potential break intended behavior of installed extensions. This should be used as a temporary solution to urgently patch/update an extension. | |
| Note: It is advisable to use this function with caution since it could potentially break intended behavior of installed extensions. This should be used as a temporary solution to urgently patch/update an extension. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Edit readme to include force overrides functionality and some minor change
Types of Changes
Changes
How to Test-Drive This PR
Checklists
General
Accessibility Compliance
You must check off all items in one of the follow two lists:
or...
Localization